/*
 * Hivemall: Hive scalable Machine Learning Library
 *
 * Copyright (C) 2015 Makoto YUI
 * Copyright (C) 2013-2015 National Institute of Advanced Industrial Science and Technology (AIST)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hivemall.io;

import hivemall.mix.MixedWeight;

import javax.annotation.Nonnull;

public interface ModelUpdateHandler {

    /**
     * @param feature
     * @param weight
     * @param covar 1.0 by the default
     * @param clock 0 by the default
     * @param deltaUpdates 
     * @return reset the deltaUpdates?
     */
    boolean onUpdate(@Nonnull Object feature, float weight, float covar, short clock, int deltaUpdates)
            throws Exception;

    void sendCancelRequest(@Nonnull Object feature, @Nonnull MixedWeight mixed) throws Exception;

}
